GUICommandManager Class Reference

#include <GUICommandManager.h>

List of all members.

Public Member Functions

 GUICommandManager (int nUndoLevel=100)
 ~GUICommandManager ()
bool CanUndo () const
bool CanRedo () const
int getUndoLevel () const
void setUndoLevel (int newValue)
bool IsDirty () const
Command * getLastUndoCommand () const
Command * getLastRedoCommand () const
void DoCommand (Command *pCommand)
void Undo ()
void Redo ()
void Clear ()
void SetClean ()
void AddUndo (Command *pCommand)
void AddRedo (Command *pCommand)
void ClearUndoList ()
void ClearRedoList ()
void ClearCommandList (CommandList *pList)

Private Types

typedef list< Command * > CommandList

Private Attributes

CommandList m_undoList
CommandList m_redoList
int m_nUndoLevel
int m_nCleanCount


Detailed Description

A GUICommandManager class.This class is used for managing the undo and redo operations.


Member Typedef Documentation

typedef list<Command* > GUICommandManager::CommandList [private]
 


Constructor & Destructor Documentation

GUICommandManager::GUICommandManager (  int  nUndoLevel = 100  )  [inline]
 

A constructor. Initializes m_nUndoLevel and m_nCleanCount variables.

Parameters:
nUndoLevel an integer argument.

GUICommandManager::~GUICommandManager (   )  [inline]
 

A destructor. Clears m_undoList and m_redoList.


Member Function Documentation

void GUICommandManager::AddRedo (  Command *  pCommand  ) 
 

pushes a Command object to the m_redoList.

Parameters:
pCommand a Command pointer.

void GUICommandManager::AddUndo (  Command *  pCommand  ) 
 

pushes a Command object to the m_undoList.

Parameters:
pCommand a Command pointer.

bool GUICommandManager::CanRedo (   )  const
 

a constant member method showing if redo operation can be performed.

Returns:
The emptiness of the m_redoList

bool GUICommandManager::CanUndo (   )  const
 

a constant member method showing if undo operation can be performed.

Returns:
The emptiness of the m_undoList

void GUICommandManager::Clear (   ) 
 

clears m_undoList and m_redoList.

void GUICommandManager::ClearCommandList (  CommandList *  pList  ) 
 

clears the given list.

Parameters:
pList a CommandList pointer.

void GUICommandManager::ClearRedoList (   ) 
 

clears m_redoList.

void GUICommandManager::ClearUndoList (   ) 
 

clears m_undoList.

void GUICommandManager::DoCommand (  Command *  pCommand  ) 
 

execute the command and add it to undo list if succeeded.

Parameters:
pCommand a Command pointer.

Command* GUICommandManager::getLastRedoCommand (   )  const
 

a constant member method returning the first redoable command object.

Returns:
The first redoable command object

Command* GUICommandManager::getLastUndoCommand (   )  const
 

a constant member method returning the last performed command object.

Returns:
The last performed command object

int GUICommandManager::getUndoLevel (   )  const
 

a constant member method returning the maximum undo level.

Returns:
The value of the m_nUndoLevel

bool GUICommandManager::IsDirty (   )  const
 

a constant member method showing if any command operation is performed.

Returns:
The m_nCleanCount size

void GUICommandManager::Redo (   ) 
 

performs redo operation to the first redoable command object.

void GUICommandManager::SetClean (   ) 
 

set m_nCleanCount as 0.

void GUICommandManager::setUndoLevel (  int  newValue  ) 
 

set the maximum undo level.

Parameters:
newValue an integer argument.

void GUICommandManager::Undo (   ) 
 

performs undo operation to the last performed command operation.


Member Data Documentation

int GUICommandManager::m_nCleanCount [private]
 

a private variable. It holds if any command operation is performed.

int GUICommandManager::m_nUndoLevel [private]
 

a private variable. It holds maximum size of the m_undoList.

CommandList GUICommandManager::m_redoList [private]
 

a private list of Command pointers. It holds the command objects on which redo operations can be performed.

CommandList GUICommandManager::m_undoList [private]
 

a private list of Command pointers. It holds the command objects on which undo operations can be performed.


The documentation for this class was generated from the following file:
Generated on Sun May 28 18:44:00 2006 by  doxygen 1.4.6-NO